/**
 * Copyright © 2014-2021 The SiteWhere Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.sitewhere.sources.spi;

import java.util.Map;

import com.sitewhere.spi.microservice.lifecycle.ITenantEngineLifecycleComponent;

/**
 * Handles receipt of device event information from an underlying transport.
 */
public interface IInboundEventReceiver<T> extends ITenantEngineLifecycleComponent {

    /**
     * Get name shown in user interfaces when referencing receiver.
     * 
     * @return
     */
    public String getDisplayName();

    /**
     * Called when an event payload is received.
     * 
     * @param payload
     * @param metadata
     */
    public void onEventPayloadReceived(T payload, Map<String, Object> metadata);

    /**
     * Set the parent event source that will process events.
     * 
     * @param source
     */
    public void setEventSource(IInboundEventSource<T> source);

    /**
     * Get the parent event source.
     * 
     * @return
     */
    public IInboundEventSource<T> getEventSource();
}